Javadoc 편집

IntelliJ IDEA은 모든 필요한 태크와 그 값과 함께 자바 블록을 생성하는  Code Completion  의 특별한 타입과 함께 Javadoc

코멘트를 추가하는 프로세스의 속도를 올립니다.

예를 들면, 당신이 다음 메소드를 가진다라고 가정합니다:  
 
 public int foo(int p1, int p2) {
 return p1 + p2;
 }
 

메소드에 대한 Javadoc 코멘트의 블록을 생성하기 위해:

메소드의 첫 번째 라인 전에(또는 시작에서) 즉시 캐럿을 위치하십시오.

/** 타이프 하고 그리고Enter를 누릅니다

메소드 매개 변수와 리턴 형태를 위한 태그와 더불어 Javadoc 블록은 메소드 선언 전에 생성됩니다.  
Javadoc 생성을 따르면(만일 메소드가 어떤 예외를 던지면, 또한 이것에 대한 태그가 있었을 것 입니다), 
메소드는 지금 이것처럼 보입니다:
 
/**
 *
 * @param p1
 * @param p2
 * @return
 */
 
 public int foo(int p1, int p2) {
 return p1 + p2;
 }
 

ADDITIONAL TAGS: 
만일 당신이 부가의 태그를 코멘트 블록을 생성하고 난 후에 입력할 필요가 있으면, Javadoc 블록 내에서 빈 문자열 중의 1개를 타이프하십시오.  문맥 메뉴는 가능한 태그명을 제안하고 있으면서 팝업합니다.



원하는 태그를 선택하고 그것을 삽입하기 위해 Enter 를 누르십시오




TAGS WITH MULTIPLE VALUES: 

일부의 경우, 만일 태그가 몇 개의 값을 가질 수 있으면, 그들을 위한 완료가 제안될 것입니다.  

태그명을 입력하고 난 후에 Ctrl + Space에 문맥 메뉴를 보기 위해 누르십시오.



MULTIPLE EXCEPTIONS: 

만일 메소드가 다중 예외를 던지면, 당신이 //*  + Enter 사용하여 Javadoc 블록을 생성할 때 메소드 시그너쳐에서 모든 선언된 예외에 대해 @throws 태그가 생성됩니다. 그러나, 당신이 메소드를 부가의 예외를 던지기 위해 변경했다라고 가정하십시오. 그러면 당신은 또 다른 @throws 태그를 기존 Javadoc에 추가하고 싶어합니다.  스마트 타입 코드 완료는 이것을 도울 수 있습니다.  @throws 태그를 타이프 하고 Ctrl + Shift + Space를 누르십시오. 룩업 목록은 메소드에 의해 던져지는 예외에 부합하고 있는 클래스를 표시하면서 팝업합니다.



ERROR HIGHLIGHTING: 

오류 강조 표시도 Javadoc 코멘트를 위해 작동합니다.  만일 당신이 태그 또는 매개 변수 이름을 부정확하게 타이프하면, 에러는 자바 구문 에러로서 똑같이 강조됩니다. 그리고 상태 표시줄은 개요를 표시합니다.

---